Choose a version:

inventoryTransferCreate

mutation

Requires write_inventory_transfers access scope. Also: The user must have permission to manage inventory.

Creates an inventory transfer.

Arguments

Anchor to inputinput •InventoryTransferCreateInput! required: The input fields for the inventory transfer.

Was this section helpful?

Anchor to InventoryTransferCreatePayload returnsInventoryTransferCreatePayload returns

Anchor to inventoryTransferinventoryTransfer •InventoryTransfer: The created inventory transfer.
Anchor to userErrorsuserErrors •[InventoryTransferCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation inventoryTransferCreate($input: InventoryTransferCreateInput!) {

inventoryTransferCreate(input: $input) {

inventoryTransfer {

# InventoryTransfer fields

}

userErrors {

field

message

}

Input

{

"input": {

"dateCreated": "2019-09-07T15:50:00Z",

"destinationLocationId": "gid://shopify/<objectName>/10079785100",

"lineItems": [

{

"inventoryItemId": "gid://shopify/<objectName>/10079785100",

"quantity": 1

}

"note": "<your-note>",

"originLocationId": "gid://shopify/<objectName>/10079785100",

"referenceName": "<your-referenceName>",

"tags": [

"<your-tags>"

]

}

{
  "input": {
    "dateCreated": "2019-09-07T15:50:00Z",
    "destinationLocationId": "gid://shopify/<objectName>/10079785100",
    "lineItems": [
      {
        "inventoryItemId": "gid://shopify/<objectName>/10079785100",
        "quantity": 1
      }
    ],
    "note": "<your-note>",
    "originLocationId": "gid://shopify/<objectName>/10079785100",
    "referenceName": "<your-referenceName>",
    "tags": [
      "<your-tags>"
    ]
  }
}

input InventoryTransferCreateInput {
  dateCreated: DateTime
  destinationLocationId: ID!
  lineItems: [InventoryTransferLineItemInput!]!
  note: String
  originLocationId: ID!
  referenceName: String
  tags: [String!]
}

input InventoryTransferLineItemInput {
  inventoryItemId: ID!
  quantity: Int!
}